HSetVol

HSetVol
Header:	Files.h		Carbon status:	Supported

Sets both the default volume and the default directory.

OSErr HSetVol (
    ConstStr63Param volName, 
    SInt16 vRefNum, 
    SInt32 dirID
);

volName: The name of a mounted volume or the partial pathname of a directory.
vRefNum: A volume reference number or a working directory reference number.
dirID: A directory ID.

function result: A result code.

DISCUSSION

The HSetVol function lets you specify the default directory by volume reference number, by directory ID, or by a combination of working directory reference number and partial pathname (beginning from that working directory).

Both the default volume and the default directory are used in calls made with no volume name, a volume reference number of 0, and a directory ID of 0.

SPECIAL CONSIDERATIONS

Use of the HSetVol function is discouraged if your application may execute in system software versions prior to version 7.0. Because the specified directory might not itself be a working directory, HSetVol records the default volume and directory separately, using the volume reference number of the volume and the actual directory ID of the specified directory. Subsequent calls to GetVol (or PBGetVolSync or PBGetVolAsync) return only the volume reference number, which will cause that volume’s root directory (rather than the default directory, as expected) to be accessed.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

CARBON NOTES

Carbon applications should use HGetVol and HSetVol to get and set the default directory. GetVol and SetVol are no longer supported and working directories are not supported.